Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update x/foundation specification #721

Merged
merged 13 commits into from
Oct 19, 2022
Merged

Conversation

0Tech
Copy link
Collaborator

@0Tech 0Tech commented Oct 17, 2022

Description

This patch will update the documentation on the x/foundation specification.
TODO: Update the references in README.md

Checklist:

  • I followed the contributing guidelines and code of conduct.
  • I have added a relevant changelog to CHANGELOG.md
  • I have added tests to cover my changes.
  • I have updated the documentation accordingly.
  • I have updated API documentation client/docs/swagger-ui/swagger.yaml

@0Tech 0Tech added the documentation Improvements or additions to documentation label Oct 17, 2022
@0Tech 0Tech self-assigned this Oct 17, 2022
@0Tech

This comment was marked as resolved.

@0Tech 0Tech marked this pull request as ready for review October 17, 2022 13:18
Copy link
Member

@zemyblue zemyblue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is not the description of GovMint.

Comment on lines +58 to +59
`x/foundation` has several messages which cannot be triggered but by the
operator. It includes membership management messages, and other messages which
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

`x/foundation` has several messages which cannot be triggered but by the
 operator.

Does It means there is several message only operator can control? I think it is a little difficult. :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I don't see any problem. Our tech docs team approved (i.e. didn't modified) this sentence and AFAIK the official docs would use it as is.

denom: stake
operator: link1...
to: link1...
metadata: show-me-the-money
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

show-me-the-money 😆

@0Tech
Copy link
Collaborator Author

0Tech commented Oct 18, 2022

There is not the description of GovMint.

I don't have enough information about the exact specification of GovMint. So I left it out. I may contact to the planning team later.

@0Tech

This comment was marked as resolved.

@0Tech 0Tech merged commit d48d8a7 into Finschia:main Oct 19, 2022
@0Tech 0Tech deleted the foundation_docs branch October 19, 2022 06:48
@zemyblue zemyblue added the C:x/foundation x/foundation module label Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:x/foundation x/foundation module documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants